orders items (http://api.3plcentral.com/rels/orders/items)
Resource:
Collection: of item
C# Rel Const:
Rels.OrderSvc.Items
URI template:
{id}/items{?detail}
Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int
detail Common.Enum.OrderItemChildren comma-delim list, for inclusion in response, default None; All = SavedElements,Allocations
Type Description
ResourceList IList<Order.Models.OrderItem>
Sample accept: application/hal+json
{
  "_embedded": {
    "http://api.3plCentral.com/rels/orders/item": [
      {
        "readOnly": {
          "orderItemId": 1,
          "fullyAllocated": true,
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "secondaryUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "estimatedQty": 1.0,
          "estimatedSecondaryQty": 1.0,
          "originalPrimaryQty": 1.0,
          "isOrderQtySecondary": true,
          "allocations": [
            {
              "receiveItemId": 1,
              "qty": 2.0,
              "properlyPickedPrimary": 3.0,
              "properlyPickedSecondary": 4.0,
              "loadedOut": true,
              "rowVersion": "str",
              "detail": {
                "itemTraits": {
                  "itemIdentifier": {
                    "sku": "str",
                    "id": 2
                  },
                  "qualifier": "str",
                  "lotNumber": "str",
                  "serialNumber": "str",
                  "cost": 1.0,
                  "expirationDate": "2016-12-25T23:00:00",
                  "palletIdentifier": {
                    "nameKey": {
                      "facilityIdentifier": {
                        "name": "str",
                        "id": 2
                      },
                      "name": "str"
                    },
                    "id": 1
                  }
                },
                "locationIdentifier": {
                  "nameKey": {
                    "facilityIdentifier": {
                      "name": "str",
                      "id": 2
                    },
                    "name": "str"
                  },
                  "id": 1
                },
                "locationSort": {
                  "field1": "str",
                  "field2": "str",
                  "field3": "str",
                  "field4": "str"
                },
                "savedElements": [
                  {
                    "name": "str",
                    "value": "str"
                  }
                ],
                "pickPath": 1
              }
            }
          ],
          "bin": "str",
          "isInsert": true,
          "maxToAllocateFromPickLine": 1.0,
          "rowVersion": "str"
        },
        "itemIdentifier": {
          "sku": "str",
          "id": 2
        },
        "qualifier": "str",
        "externalId": "str",
        "qty": 1.0,
        "secondaryQty": 1.0,
        "lotNumber": "str",
        "serialNumber": "str",
        "expirationDate": "2016-12-25T23:00:00",
        "weightImperial": 1.0,
        "weightMetric": 1.0,
        "notes": "str",
        "fulfillInvSalePrice": 1.0,
        "fulfillInvDiscountPct": 1.0,
        "fulfillInvDiscountAmt": 1.0,
        "fulfillInvNote": "str",
        "savedElements": [
          {
            "name": "str",
            "value": "str"
          }
        ],
        "proposedAllocations": [
          {
            "receiveItemId": 1,
            "qty": 2.0
          }
        ],
        "orderItemInPackages": [
          {
            "packageNumber": 1,
            "quantity": 2.0,
            "packageDefIdentifier": {
              "name": "str",
              "id": 2
            }
          }
        ],
        "isInsert": true
      }
    ]
  }
}
If-Match request header required; Success status: 201; ETag response header supplied
Name (* = required) Data Type Description
id * int
Type Description
ReadOnly Order.Models.OrderItemReadOnly
ItemIdentifier Generic.Models.ItemIdentifier
Qualifier string
ExternalId string connection of this order item to the same order item on some other system
Qty decimal? ... primary inventory quantity ordered; if not specified, must specify SecondaryQty more...
SecondaryQty decimal? ... optional secondary quantity ordered; if not specified, must specify Qty more...
LotNumber string if present, used to allocate matching inventory
SerialNumber string if present, used to allocate matching inventory
ExpirationDate DateTime? ... if present, used to allocate matching inventory
WeightImperial decimal? ... ship weight of order item, imperial; if specified and metric not specified, business logic computes metric more...
WeightMetric decimal? ... ship weight of order item, metric; if specified and imperial not specified, business logic computes imperial; see WeightImperial for further explanation
Notes string
FulfillInvSalePrice decimal? ...
FulfillInvDiscountPct decimal? ...
FulfillInvDiscountAmt decimal? ...
FulfillInvNote string
SavedElements IEnumerable<Generic.Models.SavedElement>
ProposedAllocations IEnumerable<Generic.Models.ProposedAllocation> empty on GET; may be supplied on PUT, POST
OrderItemInPackages IEnumerable<Order.Models.OrderItemInPackage> declares the package arrangement, which gets translated into real packages, during order creation; empty on GET; ignored on PUT; may be supplied on POST
IsInsert bool
Sample content-type: application/hal+json
{
  "readOnly": {
    "orderItemId": 1,
    "fullyAllocated": true,
    "unitIdentifier": {
      "name": "str",
      "id": 2
    },
    "secondaryUnitIdentifier": {
      "name": "str",
      "id": 2
    },
    "estimatedQty": 1.0,
    "estimatedSecondaryQty": 1.0,
    "originalPrimaryQty": 1.0,
    "isOrderQtySecondary": true,
    "allocations": [
      {
        "receiveItemId": 1,
        "qty": 2.0,
        "properlyPickedPrimary": 3.0,
        "properlyPickedSecondary": 4.0,
        "loadedOut": true,
        "rowVersion": "str",
        "detail": {
          "itemTraits": {
            "itemIdentifier": {
              "sku": "str",
              "id": 2
            },
            "qualifier": "str",
            "lotNumber": "str",
            "serialNumber": "str",
            "cost": 1.0,
            "expirationDate": "2016-12-25T23:00:00",
            "palletIdentifier": {
              "nameKey": {
                "facilityIdentifier": {
                  "name": "str",
                  "id": 2
                },
                "name": "str"
              },
              "id": 1
            }
          },
          "locationIdentifier": {
            "nameKey": {
              "facilityIdentifier": {
                "name": "str",
                "id": 2
              },
              "name": "str"
            },
            "id": 1
          },
          "locationSort": {
            "field1": "str",
            "field2": "str",
            "field3": "str",
            "field4": "str"
          },
          "savedElements": [
            {
              "name": "str",
              "value": "str"
            }
          ],
          "pickPath": 1
        }
      }
    ],
    "bin": "str",
    "isInsert": true,
    "maxToAllocateFromPickLine": 1.0,
    "rowVersion": "str"
  },
  "itemIdentifier": {
    "sku": "str",
    "id": 2
  },
  "qualifier": "str",
  "externalId": "str",
  "qty": 1.0,
  "secondaryQty": 1.0,
  "lotNumber": "str",
  "serialNumber": "str",
  "expirationDate": "2016-12-25T23:00:00",
  "weightImperial": 1.0,
  "weightMetric": 1.0,
  "notes": "str",
  "fulfillInvSalePrice": 1.0,
  "fulfillInvDiscountPct": 1.0,
  "fulfillInvDiscountAmt": 1.0,
  "fulfillInvNote": "str",
  "savedElements": [
    {
      "name": "str",
      "value": "str"
    }
  ],
  "proposedAllocations": [
    {
      "receiveItemId": 1,
      "qty": 2.0
    }
  ],
  "orderItemInPackages": [
    {
      "packageNumber": 1,
      "quantity": 2.0,
      "packageDefIdentifier": {
        "name": "str",
        "id": 2
      }
    }
  ],
  "isInsert": true
}
returns list because an alias sku might expand to more than one order item
Type Description
ResourceList IList<Order.Models.OrderItem>
Sample accept: application/hal+json
{
  "_embedded": {
    "http://api.3plCentral.com/rels/orders/item": [
      {
        "readOnly": {
          "orderItemId": 1,
          "fullyAllocated": true,
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "secondaryUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "estimatedQty": 1.0,
          "estimatedSecondaryQty": 1.0,
          "originalPrimaryQty": 1.0,
          "isOrderQtySecondary": true,
          "allocations": [
            {
              "receiveItemId": 1,
              "qty": 2.0,
              "properlyPickedPrimary": 3.0,
              "properlyPickedSecondary": 4.0,
              "loadedOut": true,
              "rowVersion": "str",
              "detail": {
                "itemTraits": {
                  "itemIdentifier": {
                    "sku": "str",
                    "id": 2
                  },
                  "qualifier": "str",
                  "lotNumber": "str",
                  "serialNumber": "str",
                  "cost": 1.0,
                  "expirationDate": "2016-12-25T23:00:00",
                  "palletIdentifier": {
                    "nameKey": {
                      "facilityIdentifier": {
                        "name": "str",
                        "id": 2
                      },
                      "name": "str"
                    },
                    "id": 1
                  }
                },
                "locationIdentifier": {
                  "nameKey": {
                    "facilityIdentifier": {
                      "name": "str",
                      "id": 2
                    },
                    "name": "str"
                  },
                  "id": 1
                },
                "locationSort": {
                  "field1": "str",
                  "field2": "str",
                  "field3": "str",
                  "field4": "str"
                },
                "savedElements": [
                  {
                    "name": "str",
                    "value": "str"
                  }
                ],
                "pickPath": 1
              }
            }
          ],
          "bin": "str",
          "isInsert": true,
          "maxToAllocateFromPickLine": 1.0,
          "rowVersion": "str"
        },
        "itemIdentifier": {
          "sku": "str",
          "id": 2
        },
        "qualifier": "str",
        "externalId": "str",
        "qty": 1.0,
        "secondaryQty": 1.0,
        "lotNumber": "str",
        "serialNumber": "str",
        "expirationDate": "2016-12-25T23:00:00",
        "weightImperial": 1.0,
        "weightMetric": 1.0,
        "notes": "str",
        "fulfillInvSalePrice": 1.0,
        "fulfillInvDiscountPct": 1.0,
        "fulfillInvDiscountAmt": 1.0,
        "fulfillInvNote": "str",
        "savedElements": [
          {
            "name": "str",
            "value": "str"
          }
        ],
        "proposedAllocations": [
          {
            "receiveItemId": 1,
            "qty": 2.0
          }
        ],
        "orderItemInPackages": [
          {
            "packageNumber": 1,
            "quantity": 2.0,
            "packageDefIdentifier": {
              "name": "str",
              "id": 2
            }
          }
        ],
        "isInsert": true
      }
    ]
  }
}
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int
Type Description
ResourceList IList<Order.Models.OrderItem>
Sample content-type: application/hal+json
{
  "_embedded": {
    "http://api.3plCentral.com/rels/orders/item": [
      {
        "readOnly": {
          "orderItemId": 1,
          "fullyAllocated": true,
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "secondaryUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "estimatedQty": 1.0,
          "estimatedSecondaryQty": 1.0,
          "originalPrimaryQty": 1.0,
          "isOrderQtySecondary": true,
          "allocations": [
            {
              "receiveItemId": 1,
              "qty": 2.0,
              "properlyPickedPrimary": 3.0,
              "properlyPickedSecondary": 4.0,
              "loadedOut": true,
              "rowVersion": "str",
              "detail": {
                "itemTraits": {
                  "itemIdentifier": {
                    "sku": "str",
                    "id": 2
                  },
                  "qualifier": "str",
                  "lotNumber": "str",
                  "serialNumber": "str",
                  "cost": 1.0,
                  "expirationDate": "2016-12-25T23:00:00",
                  "palletIdentifier": {
                    "nameKey": {
                      "facilityIdentifier": {
                        "name": "str",
                        "id": 2
                      },
                      "name": "str"
                    },
                    "id": 1
                  }
                },
                "locationIdentifier": {
                  "nameKey": {
                    "facilityIdentifier": {
                      "name": "str",
                      "id": 2
                    },
                    "name": "str"
                  },
                  "id": 1
                },
                "locationSort": {
                  "field1": "str",
                  "field2": "str",
                  "field3": "str",
                  "field4": "str"
                },
                "savedElements": [
                  {
                    "name": "str",
                    "value": "str"
                  }
                ],
                "pickPath": 1
              }
            }
          ],
          "bin": "str",
          "isInsert": true,
          "maxToAllocateFromPickLine": 1.0,
          "rowVersion": "str"
        },
        "itemIdentifier": {
          "sku": "str",
          "id": 2
        },
        "qualifier": "str",
        "externalId": "str",
        "qty": 1.0,
        "secondaryQty": 1.0,
        "lotNumber": "str",
        "serialNumber": "str",
        "expirationDate": "2016-12-25T23:00:00",
        "weightImperial": 1.0,
        "weightMetric": 1.0,
        "notes": "str",
        "fulfillInvSalePrice": 1.0,
        "fulfillInvDiscountPct": 1.0,
        "fulfillInvDiscountAmt": 1.0,
        "fulfillInvNote": "str",
        "savedElements": [
          {
            "name": "str",
            "value": "str"
          }
        ],
        "proposedAllocations": [
          {
            "receiveItemId": 1,
            "qty": 2.0
          }
        ],
        "orderItemInPackages": [
          {
            "packageNumber": 1,
            "quantity": 2.0,
            "packageDefIdentifier": {
              "name": "str",
              "id": 2
            }
          }
        ],
        "isInsert": true
      }
    ]
  }
}
Type Description
ResourceList IList<Order.Models.OrderItem>
Sample accept: application/hal+json
{
  "_embedded": {
    "http://api.3plCentral.com/rels/orders/item": [
      {
        "readOnly": {
          "orderItemId": 1,
          "fullyAllocated": true,
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "secondaryUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "estimatedQty": 1.0,
          "estimatedSecondaryQty": 1.0,
          "originalPrimaryQty": 1.0,
          "isOrderQtySecondary": true,
          "allocations": [
            {
              "receiveItemId": 1,
              "qty": 2.0,
              "properlyPickedPrimary": 3.0,
              "properlyPickedSecondary": 4.0,
              "loadedOut": true,
              "rowVersion": "str",
              "detail": {
                "itemTraits": {
                  "itemIdentifier": {
                    "sku": "str",
                    "id": 2
                  },
                  "qualifier": "str",
                  "lotNumber": "str",
                  "serialNumber": "str",
                  "cost": 1.0,
                  "expirationDate": "2016-12-25T23:00:00",
                  "palletIdentifier": {
                    "nameKey": {
                      "facilityIdentifier": {
                        "name": "str",
                        "id": 2
                      },
                      "name": "str"
                    },
                    "id": 1
                  }
                },
                "locationIdentifier": {
                  "nameKey": {
                    "facilityIdentifier": {
                      "name": "str",
                      "id": 2
                    },
                    "name": "str"
                  },
                  "id": 1
                },
                "locationSort": {
                  "field1": "str",
                  "field2": "str",
                  "field3": "str",
                  "field4": "str"
                },
                "savedElements": [
                  {
                    "name": "str",
                    "value": "str"
                  }
                ],
                "pickPath": 1
              }
            }
          ],
          "bin": "str",
          "isInsert": true,
          "maxToAllocateFromPickLine": 1.0,
          "rowVersion": "str"
        },
        "itemIdentifier": {
          "sku": "str",
          "id": 2
        },
        "qualifier": "str",
        "externalId": "str",
        "qty": 1.0,
        "secondaryQty": 1.0,
        "lotNumber": "str",
        "serialNumber": "str",
        "expirationDate": "2016-12-25T23:00:00",
        "weightImperial": 1.0,
        "weightMetric": 1.0,
        "notes": "str",
        "fulfillInvSalePrice": 1.0,
        "fulfillInvDiscountPct": 1.0,
        "fulfillInvDiscountAmt": 1.0,
        "fulfillInvNote": "str",
        "savedElements": [
          {
            "name": "str",
            "value": "str"
          }
        ],
        "proposedAllocations": [
          {
            "receiveItemId": 1,
            "qty": 2.0
          }
        ],
        "orderItemInPackages": [
          {
            "packageNumber": 1,
            "quantity": 2.0,
            "packageDefIdentifier": {
              "name": "str",
              "id": 2
            }
          }
        ],
        "isInsert": true
      }
    ]
  }
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.