NAV

<back to all web services

NAVOrderShipmentCreate

The following routes are available for this service:
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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<NAVOrderShipmentCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <OrderNumber>String</OrderNumber>
  <Shipment>
    <NAVOrderShipment>
      <ActualShippingCost>0</ActualShippingCost>
      <CartonWeight>0</CartonWeight>
      <Charge>0</Charge>
      <OrderShipmentSku>
        <NAVOrderShipmentSku>
          <OrderLineNumber>0</OrderLineNumber>
          <QuantityShipped>0</QuantityShipped>
          <SubstituteSkuCode>String</SubstituteSkuCode>
        </NAVOrderShipmentSku>
      </OrderShipmentSku>
      <ShipmentDetails>String</ShipmentDetails>
      <ShipmentStatus>String</ShipmentStatus>
      <ShippingCost>0</ShippingCost>
      <ShippingMethod>String</ShippingMethod>
      <ShippingSpeed>String</ShippingSpeed>
      <Tax>0</Tax>
      <TrackingNumber>String</TrackingNumber>
    </NAVOrderShipment>
  </Shipment>
  <ShipmentDateUTC>0001-01-01T00:00:00</ShipmentDateUTC>
</NAVOrderShipmentCreate>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NAVOrderShipmentCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</NAVOrderShipmentCreateResponse>