NAV

<back to all web services

NAVReturnCreate

The following routes are available for this service:
POST/returns
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 NAVReturnCreateResponse:
    rma_number: Optional[str] = None
    packing_list_u_r_i: Optional[str] = None
    total: Optional[Decimal] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVReturnHeaderCreate:
    original_order_number: Optional[str] = None
    original_order_type_id: Optional[str] = None
    rma_note: Optional[str] = None
    ship_label_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVReturnInboundSkuCreate:
    sku_code: Optional[str] = None
    order_line_number: Optional[int] = None
    quantity_returned: Optional[int] = None
    reason_type: Optional[str] = None
    rma_note: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVReturnOutboundSkuCreate:
    sku_code: Optional[str] = None
    order_line_number: Optional[int] = None
    quantity_returned: Optional[int] = None
    reason_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVReturnAddress:
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    address_line1: Optional[str] = None
    address_line2: Optional[str] = None
    address_line3: Optional[str] = None
    address_line4: Optional[str] = None
    address_line5: Optional[str] = None
    city: Optional[str] = None
    state_province_code: Optional[str] = None
    postal_code: Optional[str] = None
    county: Optional[str] = None
    country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVReturnCreate(IPost):
    header: Optional[NAVReturnHeaderCreate] = None
    inbound_skus: Optional[List[NAVReturnInboundSkuCreate]] = None
    outbound_skus: Optional[List[NAVReturnOutboundSkuCreate]] = None
    billing_address: Optional[NAVReturnAddress] = None
    shipping_address: Optional[NAVReturnAddress] = None

Python NAVReturnCreate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /returns HTTP/1.1 
Host: extensions.avon.ca 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"header":{"originalOrderNumber":"String","originalOrderTypeId":"String","rmaNote":"String","shipLabelType":"String"},"inboundSkus":[{"skuCode":"String","orderLineNumber":0,"quantityReturned":0,"reasonType":"String","rmaNote":"String"}],"outboundSkus":[{"skuCode":"String","orderLineNumber":0,"quantityReturned":0,"reasonType":"String"}],"billingAddress":{"firstName":"String","lastName":"String","addressLine1":"String","addressLine2":"String","addressLine3":"String","addressLine4":"String","addressLine5":"String","city":"String","stateProvinceCode":"String","postalCode":"String","county":"String","countryCode":"String"},"shippingAddress":{"firstName":"String","lastName":"String","addressLine1":"String","addressLine2":"String","addressLine3":"String","addressLine4":"String","addressLine5":"String","city":"String","stateProvinceCode":"String","postalCode":"String","county":"String","countryCode":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"rmaNumber":"String","packingListURI":"String","total":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}