POST | /orders/{OrderNumber}/shipments |
---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVOrderShipmentCreateResponse:
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVOrderShipmentSku:
order_line_number: Optional[int] = None
quantity_shipped: Optional[int] = None
substitute_sku_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVOrderShipment:
shipping_method: Optional[str] = None
shipping_speed: Optional[str] = None
tracking_number: Optional[str] = None
shipment_status: Optional[str] = None
shipment_details: Optional[str] = None
shipping_cost: Optional[Decimal] = None
charge: Optional[Decimal] = None
tax: Optional[Decimal] = None
actual_shipping_cost: Optional[Decimal] = None
carton_weight: Optional[Decimal] = None
order_shipment_sku: Optional[List[NAVOrderShipmentSku]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVOrderShipmentCreate(IPost):
order_number: Optional[str] = None
shipment_date_u_t_c: Optional[datetime.datetime] = None
shipment: Optional[List[NAVOrderShipment]] = None
Python NAVOrderShipmentCreate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /orders/{OrderNumber}/shipments HTTP/1.1
Host: extensions.avon.ca
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"orderNumber":"String","shipmentDateUTC":"0001-01-01T00:00:00.0000000","shipment":[{"shippingMethod":"String","shippingSpeed":"String","trackingNumber":"String","shipmentStatus":"String","shipmentDetails":"String","shippingCost":0,"charge":0,"tax":0,"actualShippingCost":0,"cartonWeight":0,"orderShipmentSku":[{"orderLineNumber":0,"quantityShipped":0,"substituteSkuCode":"String"}]}]}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}