Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Parts Ordering Response Object Formats

Include Page
_Parts Ordering Response Object Formats
_Parts Ordering Response Object Formats

Parts Ordering Response Object Properties

PropertyTypeDescription
Orderscollection
Contains a collection of one or more orders. Based on the parts being ordered, the back-end may decide to break up the order into multiple deliveries.
PropertyTypeDescription
EstimatedDeliverydatetimeThis optional field contain the estimated delivery date for the specific order.
PartOrderNumstring

Contains the order number associated with the parts order. This is a back-end generated number.

Partsobject

Contains the list of parts associated with the order.

PropertyTypeDescription

ProdNum

stringThe product number of the ordered part.
PartStatusstring

Specifies the status of ordered part. This is a simple free-form text field with no validation.

3.18.0

ProdAttrsobject

Product attributes of the ordered part.

See: Product Object

Status
title3.18.0

Qty

decimalThe quantity being ordered.
ShipToLocationstring

Optional property that identifies the location where the ordered part will be shipped to.

Status
colourYellow
title3.18.0
Status
colourYellow
title3.37.0

SupersededPartscollection

This optional collection contains a list of parts that replaces the ordered part.

Property

Type

Description

ProdNumstringThe product number of the replacement part.
PartStatusstring

Specifies the status of replacement part. This is a simple free-form text field with no validation.

ProdAttrsobject

Product attributes of the ordered part.

See: Product Object

QtydecimalThe quantity being ordered.

3.18.0

Urgencystring

Optional property that identifies the shipping urgency for the ordered parts.

Status
colourGrey
title3.18.1
Status
colourYellow
title3.37.0


TrackingNumberstring

Contains the shipping tracking number.


Statusstring

This field contains the status of the parts order request.

Valid values are:

  • 0 - OK
  • 1001 - Parts Ordering system is unavailable
  • 2001 - Error in request body
  • 3001 - Parts unavailable at this time
  • 3002 - Can’t cancel, parts have shipped
  • 3003 - Parts no longer available
StatusMsgstring

This optional field contains additional human readable text related to the returned Status. For example, if the Status value is 2001, if would be beneficial if the back-end system returned the error it detected in readable format.

Parts Ordering Response Object Formats

Include Page
_Parts Ordering Response Object Formats
_Parts Ordering Response Object Formats

Parts Ordering Response Object Properties

PropertyTypeDescription
Ordersobject
Contains a collections of one or more orders. Based on the parts being ordered, the back-end may decide to break up the order into multiple deliveries.
PropertyTypeDescription
EstimatedDeliverydatetimeThis optional field contain the estimated delivery date for the specific order.
PartOrderNumstring

Contains the order number associated with the parts order. This is a back-end generated number.

Partsobject

Contains the list of parts associated with the order.

PropertyTypeDescription

PartNumber

stringThe product number of the ordered part.
PartStatusstring

Specifies the status of ordered part. This is a simple free-form text field with no validation.

3.18.0

ProdAttrsobject

Product attributes of the ordered part.

See: Product Object

Status
title3.18.0

Quantity

decimalThe quantity being ordered.
SupersededPartscollection

This optional collection contains a list of parts that replaces the ordered part.

Property

Type

Description

PartNumberstringThe product number of the replacement part.
PartStatusstring

Specifies the status of replacement part. This is a simple free-form text field with no validation.

ProdAttrsobject

Product attributes of the ordered part.

See: Product Object

QtydecimalThe quantity being ordered.

3.18.0


ShipToLocationstring

Optional property that identifies the location where the ordered part will be shipped to.

Status
colourYellow
title3.18.0

TrackingNumberstring

Contains the shipping tracking number.

Urgencystring

Optional property that identifies the shipping urgency for the ordered parts.

Status
colourGrey
title3.18.1


Statusstring

This field contains the status of the parts order request.

Valid values are:

  • 0 - OK
  • 1001 - Parts Ordering system is unavailable
  • 2001 - Error in request body
  • 3001 - Parts unavailable at this time
  • 3002 - Can’t cancel, parts have shipped
  • 3003 - Parts no longer available
StatusMsgstring

This optional field contains additional human readable text related to the returned Status. For example, if the Status value is 2001, if would be beneficial if the back-end system returned the error it detected in readable format.